<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Unicode::Map8 - Mapping table between 8-bit chars and Unicode - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Unicode-Map8 - MetaCPAN" href="https://metacpan.org/dist/Unicode-Map8/releases.rss" />
        <link rel="canonical" href="./Unicode::Map8.html" />
        <meta name="description" content="Mapping table between 8-bit chars and Unicode" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Unicode::Map8" />
<meta name="twitter:title"       content="Unicode::Map8" />
<meta name="twitter:description" content="Mapping table between 8-bit chars and Unicode" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Unicode::Map8.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Unicode-Map8 was released.">
      <span class="relatize">18 Jan 2010 21:19:04 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Unicode-Map8">Unicode-Map8</a>
  </li>
  <li>
    Module version: 0.13
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Unicode-Map8/source/Map8.pm">Source</a>
    (<a href="https://metacpan.org/dist/Unicode-Map8/source/Map8.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Unicode-Map8/source">Browse</a>
    (<a href="https://metacpan.org/dist/Unicode-Map8/source?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Unicode-Map8/changes">Changes</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Unicode-Map8/contribute">How to Contribute</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=Unicode-Map8">Issues</a>
      (12)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Unicode-Map8+0.13" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/U/Unicode-Map8.html?oncpan=1&amp;distmat=1&amp;version=0.13&amp;grade=2" style="color: #090">29</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/U/Unicode-Map8.html?oncpan=1&amp;distmat=1&amp;version=0.13&amp;grade=3" style="color: #900">21</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/U/Unicode-Map8.html?oncpan=1&amp;distmat=1&amp;version=0.13&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/GAAS/Unicode-Map8-0.13">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Unicode-Map8 who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 0
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/Unicode-Map8-0.13/index.html">82.26% Coverage </a>
    </li>
    <li>
      License: unknown
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Unicode-Map8/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/G/GA/GAAS/Unicode-Map8-0.13.tar.gz">
      Download (<span itemprop="fileSize">96.92KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FGAAS%2FUnicode-Map8-0.13%2FMap8.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Unicode-Map8/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Unicode-Map8/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Unicode-Map8">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Unicode-Map8">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/Map8.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="GAAS/Unicode-Map8-0.13"
>0.13
  (GAAS on 2010-01-18)</option>
<option
  
  value="GAAS/Unicode-Map8-0.12"
>0.12
  (GAAS on 2002-12-28)</option>
<optgroup label="BackPAN">'
<option
  
  value="GAAS/Unicode-Map8-0.11"
>0.11
  (GAAS on 2001-12-31)</option>
<option
  
  value="GAAS/Unicode-Map8-0.10"
>0.10
  (GAAS on 2000-06-13)</option>
<option
  
  value="GAAS/Unicode-Map8-0.09"
>0.09
  (GAAS on 2000-01-21)</option>
<option
  
  value="GAAS/Unicode-Map8-0.08"
>0.08
  (GAAS on 1999-09-14)</option>
<option
  
  value="GAAS/Unicode-Map8-0.07"
>0.07
  (GAAS on 1999-06-02)</option>
<option
  
  value="ASANDSTRM/Unicode-Map8-0.06-bin-1-Mac"
>0.06-bin-1-Mac
  (ASANDSTRM on 1999-05-05)</option>
<option
  
  value="GAAS/Unicode-Map8-0.05"
>0.05
  (GAAS on 1998-07-15)</option>
<option
  
  value="GAAS/Unicode-Map8-0.04"
>0.04
  (GAAS on 1998-02-19)</option>
<option
  
  value="GAAS/Unicode-Map8-0.03"
>0.03
  (GAAS on 1998-02-13)</option>
<option
  
  value="GAAS/Unicode-Map8-0.02"
>0.02
  (GAAS on 1998-01-19)</option>
<option
  
  value="GAAS/Unicode-Map8-0.01"
>0.01
  (GAAS on 1998-01-16)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/GAAS/Unicode-Map8-0.13/diff/' + encodeURIComponent(this.value) + '/Map8.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="GAAS/Unicode-Map8-0.13"
>0.13
  (GAAS on 2010-01-18)</option>
<option
  
  value="GAAS/Unicode-Map8-0.12"
>0.12
  (GAAS on 2002-12-28)</option>
<optgroup label="BackPAN">'
<option
  
  value="GAAS/Unicode-Map8-0.11"
>0.11
  (GAAS on 2001-12-31)</option>
<option
  
  value="GAAS/Unicode-Map8-0.10"
>0.10
  (GAAS on 2000-06-13)</option>
<option
  
  value="GAAS/Unicode-Map8-0.09"
>0.09
  (GAAS on 2000-01-21)</option>
<option
  
  value="GAAS/Unicode-Map8-0.08"
>0.08
  (GAAS on 1999-09-14)</option>
<option
  
  value="GAAS/Unicode-Map8-0.07"
>0.07
  (GAAS on 1999-06-02)</option>
<option
  
  value="ASANDSTRM/Unicode-Map8-0.06-bin-1-Mac"
>0.06-bin-1-Mac
  (ASANDSTRM on 1999-05-05)</option>
<option
  
  value="GAAS/Unicode-Map8-0.05"
>0.05
  (GAAS on 1998-07-15)</option>
<option
  
  value="GAAS/Unicode-Map8-0.04"
>0.04
  (GAAS on 1998-02-19)</option>
<option
  
  value="GAAS/Unicode-Map8-0.03"
>0.03
  (GAAS on 1998-02-13)</option>
<option
  
  value="GAAS/Unicode-Map8-0.02"
>0.02
  (GAAS on 1998-01-19)</option>
<option
  
  value="GAAS/Unicode-Map8-0.01"
>0.01
  (GAAS on 1998-01-16)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="./Unicode::String.html" title="Unicode::String" class="ellipsis">Unicode::String</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Unicode::Map8/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Unicode%3A%3AMap8">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Unicode-Map8">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/GAAS/Unicode-Map8-0.13/view/Map8.pm">This version</a>
    </li>
    <li>
      <a href="./Unicode::Map8.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
    1 non-PAUSE user
</div>
</div>
    </li>
    <li>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/GAAS" class="author-name">Gisle Aas</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/Map8.pm&#39;" class="">
<option
  selected
  value="GAAS/Unicode-Map8-0.13"
>0.13
  (GAAS on 2010-01-18)</option>
<option
  
  value="GAAS/Unicode-Map8-0.12"
>0.12
  (GAAS on 2002-12-28)</option>
<optgroup label="BackPAN">'
<option
  
  value="GAAS/Unicode-Map8-0.11"
>0.11
  (GAAS on 2001-12-31)</option>
<option
  
  value="GAAS/Unicode-Map8-0.10"
>0.10
  (GAAS on 2000-06-13)</option>
<option
  
  value="GAAS/Unicode-Map8-0.09"
>0.09
  (GAAS on 2000-01-21)</option>
<option
  
  value="GAAS/Unicode-Map8-0.08"
>0.08
  (GAAS on 1999-09-14)</option>
<option
  
  value="GAAS/Unicode-Map8-0.07"
>0.07
  (GAAS on 1999-06-02)</option>
<option
  
  value="ASANDSTRM/Unicode-Map8-0.06-bin-1-Mac"
>0.06-bin-1-Mac
  (ASANDSTRM on 1999-05-05)</option>
<option
  
  value="GAAS/Unicode-Map8-0.05"
>0.05
  (GAAS on 1998-07-15)</option>
<option
  
  value="GAAS/Unicode-Map8-0.04"
>0.04
  (GAAS on 1998-02-19)</option>
<option
  
  value="GAAS/Unicode-Map8-0.03"
>0.03
  (GAAS on 1998-02-13)</option>
<option
  
  value="GAAS/Unicode-Map8-0.02"
>0.02
  (GAAS on 1998-01-19)</option>
<option
  
  value="GAAS/Unicode-Map8-0.01"
>0.01
  (GAAS on 1998-01-16)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Unicode-Map8">Unicode-Map8-0.13</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage two &#10;
          • 5 direct dependents &#10;          • 17 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Unicode-Map8-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Unicode-Map8-0.13">
    <input type="hidden" name="author" value="GAAS">
    <input type="hidden" name="distribution" value="Unicode-Map8">
    <button type="submit" class="favorite highlight"><span>1</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Unicode::Map8.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>1</span> ++</a>
</div>
   / <span>Unicode::Map8</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Unicode::Map8.html#NAME">NAME</a></li>
  <li><a href="./Unicode::Map8.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Unicode::Map8.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./Unicode::Map8.html#FILES">FILES</a></li>
  <li><a href="./Unicode::Map8.html#BUGS">BUGS</a></li>
  <li><a href="./Unicode::Map8.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./Unicode::Map8.html#COPYRIGHT">COPYRIGHT</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Unicode::Map8 - Mapping table between 8-bit chars and Unicode</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code> require Unicode::Map8;
 my $no_map = Unicode::Map8-&gt;new(&quot;ISO646-NO&quot;) || die;
 my $l1_map = Unicode::Map8-&gt;new(&quot;latin1&quot;)    || die;

 my $ustr = $no_map-&gt;to16(&quot;V}re norske tegn b|r {res\n&quot;);
 my $lstr = $l1_map-&gt;to8($ustr);
 print $lstr;

 print $no_map-&gt;tou(&quot;V}re norske tegn b|r {res\n&quot;)-&gt;utf8</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>The <i>Unicode::Map8</i> class implement efficient mapping tables between 8-bit character sets and 16 bit character sets like Unicode. The tables are efficient both in terms of space allocated and translation speed. The 16-bit strings is assumed to use network byte order.</p>

<p>The following methods are available:</p>

<dl>

<dt id="$m-=-Unicode::Map8-&gt;new(-[$charset]-)"><a id="m---Unicode::Map8--new---charset"></a>$m = Unicode::Map8-&gt;new( [$charset] )</dt>
<dd>

<p>The object constructor creates new instances of the Unicode::Map8 class. I takes an optional argument that specify then name of a 8-bit character set to initialize mappings from. The argument can also be a the name of a mapping file. If the charset/file can not be located, then the constructor returns <i>undef</i>.</p>

<p>If you omit the argument, then an empty mapping table is constructed. You must then add mapping pairs to it using the addpair() method described below.</p>

</dd>
<dt id="$m-&gt;addpair(-$u8,-$u16-);"><a id="m--addpair---u8---u16"></a>$m-&gt;addpair( $u8, $u16 );</dt>
<dd>

<p>Adds a new mapping pair to the mapping object. It takes two arguments. The first is the code value in the 8-bit character set and the second is the corresponding code value in the 16-bit character set. The same codes can be used multiple times (but using the same pair has no effect). The first definition for a code is the one that is used.</p>

<p>Consider the following example:</p>

<pre><code>  $m-&gt;addpair(0x20, 0x0020);
  $m-&gt;addpair(0x20, 0x00A0);
  $m-&gt;addpair(0xA0, 0x00A0);</code></pre>

<p>It means that the character 0x20 and 0xA0 in the 8-bit charset maps to themselves in the 16-bit set, but in the 16-bit character set 0x0A0 maps to 0x20.</p>

</dd>
<dt id="$m-&gt;default_to8(-$u8-)"><a id="m--default_to8---u8"></a>$m-&gt;default_to8( $u8 )</dt>
<dd>

<p>Set the code of the default character to use when mapping from 16-bit to 8-bit strings. If there is no mapping pair defined for a character then this default is substituted by to8() and recode8().</p>

</dd>
<dt id="$m-&gt;default_to16(-$u16-)"><a id="m--default_to16---u16"></a>$m-&gt;default_to16( $u16 )</dt>
<dd>

<p>Set the code of the default character to use when mapping from 8-bit to 16-bit strings. If there is no mapping pair defined for a character then this default is used by to16(), tou() and recode8().</p>

</dd>
<dt id="$m-&gt;nostrict;"><a id="m--nostrict"></a>$m-&gt;nostrict;</dt>
<dd>

<p>All undefined mappings are replaced with the identity mapping. Undefined character are normally just removed (or replaced with the default if defined) when converting between character sets.</p>

</dd>
<dt id="$m-&gt;to8(-$ustr-);"><a id="m--to8---ustr"></a>$m-&gt;to8( $ustr );</dt>
<dd>

<p>Converts a 16-bit character string to the corresponding string in the 8-bit character set.</p>

</dd>
<dt id="$m-&gt;to16(-$str-);"><a id="m--to16---str"></a>$m-&gt;to16( $str );</dt>
<dd>

<p>Converts a 8-bit character string to the corresponding string in the 16-bit character set.</p>

</dd>
<dt id="$m-&gt;tou(-$str-);"><a id="m--tou---str"></a>$m-&gt;tou( $str );</dt>
<dd>

<p>Same an to16() but return a Unicode::String object instead of a plain UCS2 string.</p>

</dd>
<dt id="$m-&gt;recode8($m2,-$str);"><a id="m--recode8-m2---str"></a>$m-&gt;recode8($m2, $str);</dt>
<dd>

<p>Map the string $str from one 8-bit character set ($m) to another one ($m2). Since we assume we know the mappings towards the common 16-bit encoding we can use this to convert between any of the 8-bit character sets.</p>

</dd>
<dt id="$m-&gt;to_char16(-$u8-)"><a id="m--to_char16---u8"></a>$m-&gt;to_char16( $u8 )</dt>
<dd>

<p>Maps a single 8-bit character code to an 16-bit code. If the 8-bit character is unmapped then the constant NOCHAR is returned. The default is not used and the callback method is not invoked.</p>

</dd>
<dt id="$m-&gt;to_char8(-$u16-)"><a id="m--to_char8---u16"></a>$m-&gt;to_char8( $u16 )</dt>
<dd>

<p>Maps a single 16-bit character code to an 8-bit code. If the 16-bit character is unmapped then the constant NOCHAR is returned. The default is not used and the callback method is not invoked.</p>

</dd>
</dl>

<p>The following callback methods are available. You can override these methods by creating a subclass of Unicode::Map8.</p>

<dl>

<dt id="$m-&gt;unmapped_to8"><a id="m--unmapped_to8"></a>$m-&gt;unmapped_to8</dt>
<dd>

<p>When mapping to 8-bit character string and there is no mapping defined (and no default either), then this method is called as the last resort. It is called with a single integer argument which is the code of the unmapped 16-bit character. It is expected to return a string that will be incorporated in the 8-bit string. The default version of this method always returns an empty string.</p>

<p>Example:</p>

<pre><code> package MyMapper;
 @ISA=qw(Unicode::Map8);
 
 sub unmapped_to8
 {
    my($self, $code) = @_;
    require Unicode::CharName;
    &quot;&lt;&quot; . Unicode::CharName::uname($code) . &quot;&gt;&quot;;
 }</code></pre>

</dd>
<dt id="$m-&gt;unmapped_to16"><a id="m--unmapped_to16"></a>$m-&gt;unmapped_to16</dt>
<dd>

<p>Likewise when mapping to 16-bit character string and no mapping is defined then this method is called. It should return a 16-bit string with the bytes in network byte order. The default version of this method always returns an empty string.</p>

</dd>
</dl>

<h1 id="FILES">FILES</h1>

<p>The <i>Unicode::Map8</i> constructor can parse two different file formats; a binary format and a textual format.</p>

<p>The binary format is simple. It consist of a sequence of 16-bit integer pairs in network byte order. The first pair should contain the magic value 0xFFFE, 0x0001. Of each pair, the first value is the code of an 8-bit character and the second is the code of the 16-bit character. If follows from this that the first value should be less than 256.</p>

<p>The textual format consist of lines that is either a comment (first non-blank character is &#39;#&#39;), a completely blank line or a line with two hexadecimal numbers. The hexadecimal numbers must be preceded by &quot;0x&quot; as in C and Perl. This is the same format used by the Unicode mapping files available from &lt;URL:ftp://ftp.unicode.org/Public&gt;.</p>

<p>The mapping table files are installed in the <i>Unicode/Map8/maps</i> directory somewhere in the Perl @INC path. The variable $Unicode::Map8::MAPS_DIR is the complete path name to this directory. Binary mapping files are stored within this directory with the suffix <i>.bin</i>. Textual mapping files are stored with the suffix <i>.txt</i>.</p>

<p>The scripts <i>map8_bin2txt</i> and <i>map8_txt2bin</i> can translate between these mapping file formats.</p>

<p>A special file called <i>aliases</i> within $MAPS_DIR specify all the alias names that can be used to denote the various character sets. The first name of each line is the real file name and the rest is alias names separated by space.</p>

<p>The `<code>umap --list</code>&#39; command be used to list the character sets supported.</p>

<h1 id="BUGS">BUGS</h1>

<p>Does not handle Unicode surrogate pairs as a single character.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="http://man.he.net/man1/umap">umap(1)</a>, <a href="./Unicode::String.html">Unicode::String</a></p>

<h1 id="COPYRIGHT">COPYRIGHT</h1>

<p>Copyright 1998 Gisle Aas.</p>

<p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Unicode::Map8, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Unicode::Map8</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Unicode::Map8</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Unicode::Map8.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
